<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>bonobo-app-client</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="general.html" title="General">
<link rel="prev" href="libbonobo-bonobo-application.html" title="bonobo-application">
<link rel="next" href="factories.html" title="Objects, Factories, Reference Counting">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-application.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="factories.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-app-client.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-app-client.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-app-client"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-app-client.top_of_page"></a>bonobo-app-client</span></h2>
<p>bonobo-app-client — client interface to remote <span class="type">BonoboApplication</span> objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-app-client.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-app-client.html#BonoboAppClientMsgDesc" title="BonoboAppClientMsgDesc">BonoboAppClientMsgDesc</a>;
<span class="returnvalue">BonoboAppClient</span> *   <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-new" title="bonobo_app_client_new ()">bonobo_app_client_new</a>               (<em class="parameter"><code><span class="type">Bonobo_Application</span> app_server</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-new-instance" title="bonobo_app_client_new_instance ()">bonobo_app_client_new_instance</a>      (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> argc</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> *argv[]</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send-valist" title="bonobo_app_client_msg_send_valist ()">bonobo_app_client_msg_send_valist</a>   (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> first_arg_type</code></em>,
                                                         <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send-argv" title="bonobo_app_client_msg_send_argv ()">bonobo_app_client_msg_send_argv</a>     (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *argv[]</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send" title="bonobo_app_client_msg_send ()">bonobo_app_client_msg_send</a>          (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> first_arg_type</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-app-client.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-app-client.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboAppClientMsgDesc"></a><h3>BonoboAppClientMsgDesc</h3>
<pre class="programlisting">typedef struct {
	gchar *name;
	GType  return_type;
	GType *types;		/* G_TYPE_NONE-terminated array */
	gchar *description;
} BonoboAppClientMsgDesc;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-app-client-new"></a><h3>bonobo_app_client_new ()</h3>
<pre class="programlisting"><span class="returnvalue">BonoboAppClient</span> *   bonobo_app_client_new               (<em class="parameter"><code><span class="type">Bonobo_Application</span> app_server</code></em>);</pre>
<p>
<em class="parameter"><code>app_server</code></em>: object reference to a Bonobo::Application; this
function takes ownership of this reference (use
<a class="link" href="libbonobo-bonobo-object.html#bonobo-object-dup-ref" title="bonobo_object_dup_ref ()"><code class="function">bonobo_object_dup_ref()</code></a> if you want to keep your own reference.)
</p>
<p>
Create an application client object connected to the remote (or
local) Bonobo::Application object.
</p>
<p>
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>Applications should not use this function. See
<a class="link" href="libbonobo-bonobo-application.html#bonobo-application-register-unique" title="bonobo_application_register_unique ()"><code class="function">bonobo_application_register_unique()</code></a>.</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_server</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <span class="type">BonoboAppClient</span> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-app-client-new-instance"></a><h3>bonobo_app_client_new_instance ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                bonobo_app_client_new_instance      (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> argc</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> *argv[]</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>);</pre>
<p>
Ask the application server to emit a "new-instance" signal
containing the specified string vector.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_client</code></em> :</span></p></td>
<td>a <span class="type">BonoboAppClient</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>length of <em class="parameter"><code>argv</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>array of command-line arguments
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_env</code></em> :</span></p></td>
<td>a <span class="type">CORBA_Environment</span>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the message return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-app-client-msg-send-valist"></a><h3>bonobo_app_client_msg_send_valist ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            bonobo_app_client_msg_send_valist   (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> first_arg_type</code></em>,
                                                         <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
<p>
See <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send" title="bonobo_app_client_msg_send ()"><code class="function">bonobo_app_client_msg_send()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_client</code></em> :</span></p></td>
<td>client
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>message name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_env</code></em> :</span></p></td>
<td>optional corba environment
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_arg_type</code></em> :</span></p></td>
<td>first message parameter
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>var_args</code></em> :</span></p></td>
<td>remaining parameters
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-app-client-msg-send-argv"></a><h3>bonobo_app_client_msg_send_argv ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            bonobo_app_client_msg_send_argv     (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *argv[]</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>);</pre>
<p>
Like <a class="link" href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send" title="bonobo_app_client_msg_send ()"><code class="function">bonobo_app_client_msg_send()</code></a>, except that it receives a single
argument vector instead of a variable number of arguments.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_client</code></em> :</span></p></td>
<td>client
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>message name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated vector of pointers to GValue, the arguments
to pass with the message.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_env</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the message return value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-app-client-msg-send"></a><h3>bonobo_app_client_msg_send ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *            bonobo_app_client_msg_send          (<em class="parameter"><code><span class="type">BonoboAppClient</span> *app_client</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *opt_env</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> first_arg_type</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Send a message to the application server. Takes a variable length
argument list of GType, value pairs, terminated with
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-NONE:CAPS"><code class="literal">G_TYPE_NONE</code></a>. Values are direct C values, not GValues! Example:
</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">GValue</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">retval</span><span class="symbol">;</span>
<span class="normal">retval </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libbonobo-bonobo-app-client.html#bonobo-app-client-msg-send">bonobo_app_client_msg_send</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">app_client</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"openURL"</span><span class="symbol">,</span>
<span class="normal">                                     <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"http://www.gnome.org"</span><span class="symbol">,</span>
<span class="normal">                                     <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS">G_TYPE_BOOLEAN</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span>
<span class="normal">                                     <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-NONE:CAPS">G_TYPE_NONE</a></span><span class="symbol">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_client</code></em> :</span></p></td>
<td>the client interface associated with the application
to which we wish to send a message
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>message name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_env</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>first_arg_type</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>arguments
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a GValue containing the value returned from the
aplication server.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>